Style Content

MGLSource is an abstract base class for map content sources. A map content source supplies content to be shown on the map. A source is added to an MGLStyle object along with an MGLForegroundStyleLayer object. The foreground style layer defines the appearance of any content supplied by the source.

Each source defined by the style JSON file is represented at runtime by an MGLSource object that you can use to refine the map’s content. You can also add and remove sources dynamically using methods such as -[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

Create instances of MGLShapeSource, MGLImageSource and the concrete subclasses of MGLTileSource (MGLVectorSource and MGLRasterSource) in order to use MGLSource‘s properties and methods. Do not create instances of MGLSource directly, and do not create your own subclasses of this class.

MGLTileSource is a map content source that supplies map tiles to be shown on the map. The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification. A tile source is added to an MGLStyle object along with one or more MGLRasterStyleLayer or MGLVectorStyleLayer objects. Use a style layer to control the appearance of content supplied by the tile source.

A tile source is also known as a tile set. To learn about the structure of a Mapbox-hosted tile set, view it in Mapbox Studio’s Tilesets editor.

Create instances of MGLRasterSource and MGLVectorSource in order to use MGLTileSource‘s properties and methods. Do not create instances of MGLTileSource directly, and do not create your own subclasses of this class.

MGLImageSource is a content source that is used for a georeferenced raster image to be shown on the map. The georeferenced image scales and rotates as the user zooms and rotates the map. Images may also be used as icons or patterns in a style layer. To register an image for use as an icon or pattern, use the -[MGLStyle setImage:forName:] method. To configure a point annotation’s image, use the MGLAnnotationImage class.

The geographic location of the raster image content, supplied with MGLCoordinateQuad, can be non-axis aligned. MGLImageSource supports raster content from NSURL, NSImage (macOS), or UIImage (iOS). An image source is added to an MGLStyle object along with one or more MGLRasterStyleLayer objects. Use a raster style layer to control the appearance of content supplied by the image source.

Each image source defined by the style JSON file is represented at runtime by an MGLImageSource object that you can use to initialize new style layers. You can also add and remove sources dynamically using methods such as -[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

Example

let coordinates = MGLCoordinateQuad(
  topLeft: CLLocationCoordinate2D(latitude: 46.437, longitude: -80.425),
  bottomLeft: CLLocationCoordinate2D(latitude: 37.936, longitude: -80.425),
  bottomRight: CLLocationCoordinate2D(latitude: 37.936, longitude: -71.516),
  topRight: CLLocationCoordinate2D(latitude: 46.437, longitude: -71.516))
let source = MGLImageSource(identifier: "radar", coordinateQuad: coordinates, url: URL(string: "https://www.mapbox.com/mapbox-gl-js/assets/radar.gif")!)
mapView.style?.addSource(source)

MGLAbstractShapeSource is an abstract base class for map content sources that supply vector shapes to be shown on the map. A shape source is added to an MGLStyle object along with an MGLVectorStyleLayer object. The vector style layer defines the appearance of any content supplied by the shape source.

Do not create instances of this class directly, and do not create your own subclasses of this class. Instead, create instances of MGLShapeSource or MGLComputedShapeSource.

MGLShapeSource is a map content source that supplies vector shapes to be shown on the map. The shapes may be instances of MGLShape or MGLFeature, or they may be defined by local or external GeoJSON code. A shape source is added to an MGLStyle object along with an MGLVectorStyleLayer object. The vector style layer defines the appearance of any content supplied by the shape source. You can update a shape source by setting its shape or URL property.

Each geojson source defined by the style JSON file is represented at runtime by an MGLShapeSource object that you can use to refine the map’s content and initialize new style layers. You can also add and remove sources dynamically using methods such as -[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

Any vector style layer initialized with a shape source should have a nil value in its sourceLayerIdentifier property.

Example

var coordinates: [CLLocationCoordinate2D] = [
    CLLocationCoordinate2D(latitude: 37.77, longitude: -122.42),
    CLLocationCoordinate2D(latitude: 38.91, longitude: -77.04),
]
let polyline = MGLPolylineFeature(coordinates: &coordinates, count: UInt(coordinates.count))
let source = MGLShapeSource(identifier: "lines", features: [polyline], options: nil)
mapView.style?.addSource(source)

A source for vector data that is fetched one tile at a time. Useful for sources that are too large to fit in memory, or are already divided into tiles, but not in Mapbox Vector Tile format.

Supported options are MGLShapeSourceOptionMinimumZoomLevel, MGLShapeSourceOptionMaximumZoomLevel, MGLShapeSourceOptionBuffer, and MGLShapeSourceOptionSimplificationTolerance. This source does not support clustering.

MGLRasterSource is a map content source that supplies raster image tiles to be shown on the map. The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification. A raster source is added to an MGLStyle object along with one or more MGLRasterStyleLayer objects. Use a raster style layer to control the appearance of content supplied by the raster source.

Each raster source defined by the style JSON file is represented at runtime by an MGLRasterSource object that you can use to initialize new style layers. You can also add and remove sources dynamically using methods such as -[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

Example

let source = MGLRasterSource(identifier: "clouds", tileURLTemplates: ["https://example.com/raster-tiles/{z}/{x}/{y}.png"], options: [
    .minimumZoomLevel: 9,
    .maximumZoomLevel: 16,
    .tileSize: 512,
    .attributionInfos: [
        MGLAttributionInfo(title: NSAttributedString(string: "© Mapbox"), url: URL(string: "http://mapbox.com"))
    ]
])
mapView.style?.addSource(source)

MGLRasterDEMSource is a map content source that supplies rasterized digital elevation model (DEM) tiles to be shown on the map. The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification. A raster DEM source is added to an MGLStyle object along with one or more MGLHillshadeStyleLayer objects. Use a hillshade style layer to control the appearance of content supplied by the raster DEM source.

Each raster-dem source defined by the style JSON file is represented at runtime by an MGLRasterDEMSource object that you can use to initialize new style layers. You can also add and remove sources dynamically using methods such as -[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

Currently, raster DEM sources only support the format used by Mapbox Terrain-RGB.

Example

let terrainRGBURL = URL(string: "mapbox://mapbox.terrain-rgb")!
let source = MGLRasterDEMSource(identifier: "hills", configurationURL: terrainRGBURL)
mapView.style?.addSource(source)

MGLVectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map. The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification. A vector source is added to an MGLStyle object along with one or more MGLVectorStyleLayer objects. A vector style layer defines the appearance of any content supplied by the vector source.

Each vector source defined by the style JSON file is represented at runtime by an MGLVectorSource object that you can use to initialize new style layers. You can also add and remove sources dynamically using methods such as -[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

Within each vector tile, each geometric coordinate must lie between −1 × extent and (extent × 2) − 1, inclusive. Any vector style layer initialized with a vector source must have a non-nil value in its sourceLayerIdentifier property.

Commonly used vector sources include Mapbox Streets, Mapbox Terrain, and Mapbox Traffic.

Example

let source = MGLVectorSource(identifier: "pois", tileURLTemplates: ["https://example.com/vector-tiles/{z}/{x}/{y}.mvt"], options: [
    .minimumZoomLevel: 9,
    .maximumZoomLevel: 16,
    .attributionInfos: [
        MGLAttributionInfo(title: NSAttributedString(string: "© Mapbox"), url: URL(string: "http://mapbox.com"))
    ]
])
mapView.style?.addSource(source)